Northern Region Patient Demographics FHIR API icon

Northern Region Patient Demographics FHIR API

(0 reviews)

FHIR Location Data Guide

DATA ELEMENTSDATA TYPECARDINALITYSAMPLE VALUEAVAILABILITYCOMMENTS
resourceTypeLocation0..*"Location"ALL DHBsFixed Value
idstring0..1ALL DHBs
metaMeta0..1ALL DHBs
````meta.versionIdid0..1ALL DHBsIndicates the Patient IG version number.
````meta.lastUpdatedinstant0..1ALL DHBsThe version of the patient record in PAS is not kept. Source data is also derived from several tables in source. So, timestamp may be different per table.
````meta.sourceuri0..1ALL DHBs"Identifies the PAS system where information was drawn from. Value is "CMS" for ADHB, "WebPAS" for NDHB and "iPM" for CMH and WDHB."
````meta.profilecanonical(Structure Definition)0..*ALL DHBsFixed Value: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPatient
````meta.security.codecode0..1"N"ALL DHBsFixed Value
````meta.security.displaystring0..1"Normal"ALL DHBsFixed Value
identifier[i]Identifier0..*ALL DHBs
````identifier: HPIFacIdIdentifier0..1ALL DHBs
````````identifier.usecode1..1"official"ALL DHBsFixed Value
````````identifier.typeCodeableConcept0..1ALL DHBs
````````````identifier.type.coding.systemuri0..1(see comments)ALL DHBsFixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
````````````identifier.type.codecode0..1"HPIFacilityID"ALL DHBsFixed Value
````````````identifier.type.displaystring0..1"HPIFacilityID"ALL DHBsFixed Value
```````````identifier.type.textstring0..1"HPIFacilityID"ALL DHBsFixed Value
````````identifier.systemuri0..1(see comments)ALL DHBsFixed Value: https://standards.digital.health.nz/ns/hpi-facility-id
````````identifier valuestring0..1"F2L034-E"ALL DHBsThis is the current HPI Facility ID from Ministry of Health
````identifier: MOHFacIdIdentifier0..1ALL DHBs
````````identifier.usecode1..1"old"ALL DHBsFixed Value
````````identifier.typeCodeableConcept0..1ALL DHBs
````````````identifier.type.coding.systemuri0..1ALL DHBsFixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
````````````identifier.type.codecode0..1"HPIFacilityID"ALL DHBsFixed Value
````````````identifier.type.displaystring0..1"HPIFacilityID"ALL DHBsFixed Value
```````````identifier.type.textstring0..1"HPIFacilityID"ALL DHBsFixed Value
````````identifier.systemuri0..1ALL DHBsFixed Value: https://standards.digital.health.nz/ns/legacy-tbd-id
````````identifier valuestring0..1"A212"ALL DHBsThis is the legacy facility id from Ministry of Health.
namestring0..1"EastMed Doctors"ALL DHBs
alias.valuestring0..1"D301"NDHBCurrently only used by NDHB
typeCodeableConcept0..*n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
partOf0..1(see comments)n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
telecom[i]ContactPoint0..*ALL DHBs
````telecom.authorized-by-patientExtension: Boolean0..*n/anot used
````telecom.validated-by-patientExtension: Boolean0..*n/anot used
````telecom.systemcode0..1"phone"ALL DHBs"Possible values are "phone", "fax", "email", "other". Values "url" and "sms" are not used."
````telecom.valuestring0..1271234567ALL DHBsValue may be a phone number or email address
````telecom.usecode0..1"work"ALL DHBs"Possible values are "home", "work", "mobile". Values "temp" and "old" are not used. Only ADHB can have location.telecom.use = "home"."
address[i]NzAddress1..*ALL DHBsPractice address
````address.idstring0..1n/aNot used
````address.nz-geocode(Complex)0..*n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````address.suburbExtension: String0..*ADHB, CMH
````````address.suburb.urluri1..1(see comments)ADHB, CMH
````````address.suburb.valuestring0..1"Pakuranga Heights"ADHB, CMH
````address.building-nameExtension: String0..*n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````address.domicileExtension; Codeable Concept0..1ADHBNot available in CMH, NDHB and WDHB.
````````address.domain.urluri1..1(see comments)ADHBFixed Value: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
````````address.domain.coding.systemuri0..1(see comments)ADHBFixed Value: https://standards.digital.health.nz/ns/domicile-code
````````address.domain.codecode0..1"11"ADHBDomicile code associated to the address.
````````address.domain.displaystring0..1"Northland"ADHB
````````address.domain.textstring0..1"Northland"ADHBSame as display value.
````address.authorized-by-patientExtension: Boolean0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````address.validated-by-patientExtension: Boolean0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````address.usecode0..1"work"ADHB
````address.typecode0..1"postal"ADHB
````address.textstring0..1(see comments)ALL DHBs"This is the concatenation of address lines 1 to 4, postal code, country with "," (comma) as delimiter. For example - "Bream Bay Medical Centre, Town Centre, Marsden Point Road, P O Box 132, Ruakaka, 0116, New Zealand"
````address.line[x]string0..*ALL DHBs
````````address.line[1]string"6A Edgerley Avenue"ADHB, CMH
````````address.line[2]string"Epsom"ADHB, CMH
````````address.line[3]string"Auckland"ADHB, CMH
````````address.line[4]stringADHB, CMH
````address.citystring0..1"Auckland"ADHB, CMH, WDHBNDHB do not have practice location city.
````address.postalCodestring0..1"1023"CMH, NDHB, WDHBADHB do not have practice location postal code.
````address.countrystring0..1"New Zealand"ALL DHBsFixed Value
endpoint0..*ALL DHBs
````endpoint.referencestring0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````endpoint.typeuri0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````endpoint.identifierIdentifier0..1n/aThis is a placeholder element and presently not used by any of the 4 DHBs.
````endpoint.displaystring0..1"glendow"ALL DHBsContains the practice Healthlink EDI information.

Reviews